package com.example.societiesSystem.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 描述：Knife4j配置类
 *
 * 该配置类用于配置Swagger2和Knife4j，以便生成和展示API文档。
 */
@EnableSwagger2
@EnableKnife4j
@Configuration
public class Knife4jConfig {

    /**
     * 创建一个Docket实例，用于配置Swagger2文档。
     *
     * @return Docket实例
     */
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())  // 设置API信息
                .groupName("接口文档")  // 设置分组名称
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))  // 扫描带有@RestController注解的类
                .paths(PathSelectors.any())  // 扫描所有路径
                .build();
        return docket;
    }

    /**
     * 创建ApiInfo实例，用于设置API文档的基本信息。
     *
     * @return ApiInfo实例
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")  // 设置文档标题
                .description("使用Knife4j构建的Spring Boot API文档")  // 设置文档描述
                .termsOfServiceUrl("http://127.0.0.1:8888")  // 设置服务条款URL
//                .contact("lm3257@163.com")  // 设置联系人信息
                .version("1.0")  // 设置版本号
                .build();
    }
}
